tsparticles-shape-image

tsParticles Image Shape

tsParticles additional image shape.

How to use it

CDN / Vanilla JS / jQuery

The CDN/Vanilla version JS has one required file in vanilla configuration:

Including the tsparticles.shape.image.min.js file will export the function to load the shape:

loadImageShape;

Usage

Once the scripts are loaded you can set up tsParticles and the shape like this:

(async () => {
  await loadImageShape(tsParticles);

  await tsParticles.load({
    id: "tsparticles",
    options: {
      /* options */
      /* here you can use particles.shape.type: "image" */
    },
  });
})();

ESM / CommonJS

This package is compatible also with ES or CommonJS modules, firstly this needs to be installed, like this:

$ npm install tsparticles-shape-image

or

$ yarn add tsparticles-shape-image

Then you need to import it in the app, like this:

const { tsParticles } = require("tsparticles-engine");
const { loadImageShape } = require("tsparticles-shape-image");

(async () => {
  await loadImageShape(tsParticles);
})();

or

import { tsParticles } from "tsparticles-engine";
import { loadImageShape } from "tsparticles-shape-image";

(async () => {
  await loadImageShape(tsParticles);
})();

Changelog

2.12.0 (2023-08-03)

Bug Fixes

• fix issue with change theme when an existing canvas is used (2c4c7cd)
• fix issue with change theme when an existing canvas is used (a349b97)
• fixed issue with some plugins that were drawn before the canvas clear (4cff7e6)
• fixed light interaction, particle shadow wasn't calculated correctly (da86a37)
• fixed memory leak in destroyed particles by updaters, the z array wasn't filtered (272bb47), closes #5101
• fixed out mode bounce (aafaa08)
• fixed out modes, bounce was not checking the direction of the update request (e2b2c94)
• fixed pool on particles destroyed by updaters (1f62e29)

Features

• added range values to life duration and delay of emitters (18bc70d)
• added two new bundles: basic and all (489f591)